Skip to content

Update OpenAPI spec (5164ba2) - #148

Merged
workos-sdk-automation[bot] merged 1 commit into
mainfrom
update-spec-20260903-205620-33805057775
Sep 3, 2026
Merged

Update OpenAPI spec (5164ba2)#148
workos-sdk-automation[bot] merged 1 commit into
mainfrom
update-spec-20260903-205620-33805057775

Conversation

@workos-sdk-automation

@workos-sdk-automation workos-sdk-automation Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

🤖 I see new OpenAPI changes beep boop

Automated update from https://github.com/workos/workos/tree/5164ba2bff4ffea4573609550ded71f7b0135837

Source PRs

  • workos/workos#71419
Changes 



└─┬Components
  └─┬Schemas
    └─┬DataIntegrationsListResponse
      └─┬Properties
        └─┬data
          ├──[🔀] description (43422:24)
          └─┬Schema
            ├──[➕] required (43421:17)❌ 
            ├──[➕] properties/connected_accounts (43259:15)
            └─┬Properties
              └─┬connected_account
                └─┬ONEOF
                  └─┬Properties
                    ├─┬config
                    │ └──[🔀] example (43196:34)
                    └─┬scopes
                      └──[🔀] example (43146:34)


| Document Element | Total Changes | Breaking Changes |
|------------------|---------------|------------------|
| components       | 5             | 1                |

Date: 09/03/26 | Commit: Update OpenAPI spec from workos/workos@5164ba2bff4ffea4573609550ded71f7b0135837

- ❌ **BREAKING Changes**: _1_ out of _5_
- **Modifications**: _3_
- **Additions**: _2_
- **Breaking Additions**: _1_

ERROR: breaking changes discovered

@greptile-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown

Greptile Summary

The PR synchronizes the canonical OpenAPI specification to upstream revision 5164ba2, adding a required connected_accounts collection to data-integration provider responses while retaining the legacy singular field.

  • Adds the connected-account collection and updates the response description.
  • Reuses YAML examples between the singular and collection schemas.
  • Advances the source synchronization marker.

Confidence Score: 4/5

The PR appears safe to merge, with a non-blocking recommendation to derive the new collection items from the canonical connected-account schema.

The new response field is coherently documented, but its inline item definition already differs from the reusable resource schema and can drift further as the contract evolves.

Files Needing Attention: spec/open-api-spec.yaml

Important Files Changed

Filename Overview
spec/open-api-spec.yaml Adds the required connected_accounts response collection; the inline item duplication creates a non-blocking schema consistency concern.
.last-synced-sha Updates the synchronization marker to the upstream revision represented by the specification change.
Prompt To Fix All With AI 
### Issue 1
spec/open-api-spec.yaml:43261-43263
**Duplicated connected-account schema**

The new collection repeats the connected-account resource inline, and its required fields already differ from the reusable `ConnectedAccount` schema. Maintaining two definitions creates incompatible generated models and requires future resource changes to be duplicated manually.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "Update OpenAPI spec from workos/workos@5..." | Re-trigger Greptile

greptile-apps[bot]
greptile-apps Bot reviewed Sep 3, 2026
View reviewed changes
Comment thread spec/open-api-spec.yaml
Comment on lines +43261 to +43263
items:
type: object
properties:

@greptile-apps greptile-apps Bot Sep 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Duplicated connected-account schema

The new collection repeats the connected-account resource inline, and its required fields already differ from the reusable ConnectedAccount schema. Maintaining two definitions creates incompatible generated models and requires future resource changes to be duplicated manually.

Knowledge Base Used:

Prompt To Fix With AI 
This is a comment left during a code review.
Path: spec/open-api-spec.yaml
Line: 43261-43263

Comment:
**Duplicated connected-account schema**

The new collection repeats the connected-account resource inline, and its required fields already differ from the reusable `ConnectedAccount` schema. Maintaining two definitions creates incompatible generated models and requires future resource changes to be duplicated manually.

**Knowledge Base Used:**
- [OpenAPI service contract](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/openapi-spec/-/docs/openapi-contract.md)
- [API resource surface](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/openapi-spec/-/docs/api-resource-surface.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

github-actions Bot added a commit that referenced this pull request Sep 3, 2026
@github-actions
Update PR #148 SDK diff preview
23f8dad
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

SDK compatibility report

📄 View full code diff

Language Breaking Soft-risk Additive
dotnet 14 0 1
go 0 0 1
ios 71 0 1
kotlin 0 0 1
php 3 0 1
python 0 0 1
ruby 0 0 1
rust 0 0 1

Changes by domain

Domain Breaking Soft-risk Additive Languages
Authorization 32 — — ios
UserManagement 15 — — ios
Events 9 — — ios
Pipes 5 — — ios
SessionCreatedDataStatus 5 — — dotnet
SSO 5 — — ios
WaitlistUserState 5 — — dotnet
CreateDataIntegrationAuthMethods 4 — — dotnet, php
AdminPortal 3 — — ios
AuditLogs 2 — — ios
DataIntegrationsListResponseData — — 1 all

Breaking (85)

AdminPortal

Parameter changes (3)

Method Changes Languages
AdminPortal.generateLink organization moved 0→2; returnUrl moved 1→0; successUrl moved 2→1 ios

AuditLogs

Parameter changes (2)

Method Changes Languages
AuditLogs.createSchema targets moved 1→2; actor moved 2→1 ios

Authorization

Parameter changes (32)

Method Changes Languages
Authorization.createOrganizationRole name moved 1→2; slug moved 2→1 ios
Authorization.createResource resourceTypeSlug moved 2→3; organizationId moved 3→4; description moved 4→2 ios
Authorization.listMembershipsForResource permissionSlug moved 1→5; before moved 2→1; after moved 3→2; limit moved 4→3; order moved 5→4 ios
Authorization.listMembershipsForResourceAutoPaging permissionSlug moved 1→4; before moved 2→1; limit moved 3→2; order moved 4→3 ios
Authorization.listMembershipsForResourceByExternalId permissionSlug moved 3→7; before moved 4→3; after moved 5→4; limit moved 6→5; order moved 7→6 ios
Authorization.listMembershipsForResourceByExternalIdAutoPaging permissionSlug moved 3→6; before moved 4→3; limit moved 5→4; order moved 6→5 ios
Authorization.listResourcesForMembership permissionSlug moved 1→5; before moved 2→1; after moved 3→2; limit moved 4→3; order moved 5→4 ios
Authorization.listResourcesForMembershipAutoPaging permissionSlug moved 1→4; before moved 2→1; limit moved 3→2; order moved 4→3 ios

CreateDataIntegrationAuthMethods

1 enum, 3 enum values removed
Symbol Kind Languages
CreateDataIntegrationAuthMethods enum dotnet, php
CreateDataIntegrationAuthMethods.ApiKey enum value dotnet, php
CreateDataIntegrationAuthMethods.OAuth enum value dotnet, php
CreateDataIntegrationAuthMethods.Unknown enum value dotnet

Events

Parameter changes (9)

Method Changes Languages
Events.list events moved 0→4; before moved 1→0; after moved 2→1; limit moved 3→2; order moved 4→3 ios
Events.listAutoPaging events moved 0→3; before moved 1→0; limit moved 2→1; order moved 3→2 ios

Pipes

Parameter changes (5)

Method Changes Languages
Pipes.updateDataIntegrationApiKey secret moved 2→3; organizationId moved 3→2 ios
Pipes.updateDataIntegrationClientCredentials clientId moved 2→3; clientSecret moved 3→4; organizationId moved 4→2 ios

SessionCreatedDataStatus

1 enum, 4 enum values removed
Symbol Kind Languages
SessionCreatedDataStatus enum dotnet
SessionCreatedDataStatus.Active enum value dotnet
SessionCreatedDataStatus.Expired enum value dotnet
SessionCreatedDataStatus.Revoked enum value dotnet
SessionCreatedDataStatus.Unknown enum value dotnet

SSO

Parameter changes (5)

Method Changes Languages
SSO.getAuthorizationUrl redirectUri moved 0→4; providerScopes moved 1→0; providerQueryParams moved 2→1; domain moved 3→2; provider moved 4→3 ios

UserManagement

Parameter changes (15)

Method Changes Languages
UserManagement.getAuthorizationUrl redirectUri moved 0→14; codeChallengeMethod moved 1→0; codeChallenge moved 2→1; domainHint moved 3→2; connectionId moved 4→3; providerQueryParams moved 5→4; providerScopes moved 6→5; invitationToken moved 7→6; maxAge moved 8→7; screenHint moved 9→8; loginHint moved 10→9; provider moved 11→10; prompt moved 12→11; state moved 13→12; organizationId moved 14→13 ios

WaitlistUserState

1 enum, 4 enum values removed
Symbol Kind Languages
WaitlistUserState enum dotnet
WaitlistUserState.Approved enum value dotnet
WaitlistUserState.Denied enum value dotnet
WaitlistUserState.Pending enum value dotnet
WaitlistUserState.Unknown enum value dotnet

Additive (1)

DataIntegrationsListResponseData

Change Languages
DataIntegrationsListResponseData.ConnectedAccounts added (field) dotnet
📄 src/WorkOS.net/Entities/DataIntegrationsListResponseData.cs
go
📄 models.go
ios
📄 Sources/WorkOS/Models/DataIntegrationsListResponseData.swift
kotlin
📄 src/main/kotlin/com/workos/models/DataIntegrationsListResponseData.kt
php
📄 lib/Resource/DataIntegrationsListResponseData.php
python
📄 src/workos/pipes/models/data_integrations_list_response_data.py
ruby
📄 lib/workos/pipes/data_integrations_list_response_data.rb
rust
📄 src/models/data_integrations_list_response_data.rs

@workos-sdk-automation
workos-sdk-automation Bot merged commit 9440643 into main Sep 3, 2026
12 of 13 checks passed
@workos-sdk-automation
workos-sdk-automation Bot deleted the update-spec-20260903-205620-33805057775 branch September 3, 2026 21:10
github-actions Bot added a commit that referenced this pull request Sep 3, 2026
@github-actions
Remove PR #148 SDK diff preview
873179b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Assignees

No one assigned

Labels

autogenerated potentially breaking

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants